<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Abstraction Layer (HAL)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Hardware Abstraction Layer (HAL)</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('struct__cyhal__audioss__interface__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">_cyhal_audioss_interface_t Struct Reference<div class="ingroups"><a class="el" href="group__group__hal__impl.html">CAT1 Implementation Specific</a> &raquo; <a class="el" href="group__group__hal__impl__hw__types.html">CAT1 Specific Hardware Types</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p >Interface to abstract away the driver-specific differences between TDM and I2S. </p>
<p >Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae21faa347539cbf2969539748d346e64"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cyhal__audioss__interface__t.html#ae21faa347539cbf2969539748d346e64">invoke_user_callback</a> )(struct _cyhal_audioss_s *obj, uint32_t hal_event)</td></tr>
<tr class="memdesc:ae21faa347539cbf2969539748d346e64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invoke the user callback with the specified HAL event.  <a href="struct__cyhal__audioss__interface__t.html#ae21faa347539cbf2969539748d346e64">More...</a><br /></td></tr>
<tr class="separator:ae21faa347539cbf2969539748d346e64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b71f7a381aa9e56f0ecf5fc1fe9e89"><td class="memItemLeft" align="right" valign="top"><a id="a25b71f7a381aa9e56f0ecf5fc1fe9e89" name="a25b71f7a381aa9e56f0ecf5fc1fe9e89"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>event_mask_empty</b></td></tr>
<tr class="memdesc:a25b71f7a381aa9e56f0ecf5fc1fe9e89"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL event mask that represents the empty state. <br /></td></tr>
<tr class="separator:a25b71f7a381aa9e56f0ecf5fc1fe9e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9e41dd6253b3f8de07634e49e891f44"><td class="memItemLeft" align="right" valign="top"><a id="ac9e41dd6253b3f8de07634e49e891f44" name="ac9e41dd6253b3f8de07634e49e891f44"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>event_mask_half_empty</b></td></tr>
<tr class="memdesc:ac9e41dd6253b3f8de07634e49e891f44"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL event mask that represents the half empty state. <br /></td></tr>
<tr class="separator:ac9e41dd6253b3f8de07634e49e891f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac678187b982a338f7881f6c08d313c7c"><td class="memItemLeft" align="right" valign="top"><a id="ac678187b982a338f7881f6c08d313c7c" name="ac678187b982a338f7881f6c08d313c7c"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>event_mask_full</b></td></tr>
<tr class="memdesc:ac678187b982a338f7881f6c08d313c7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL event mask that represents the full state. <br /></td></tr>
<tr class="separator:ac678187b982a338f7881f6c08d313c7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86f8875bf98bf422e046a85bd9a72240"><td class="memItemLeft" align="right" valign="top"><a id="a86f8875bf98bf422e046a85bd9a72240" name="a86f8875bf98bf422e046a85bd9a72240"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>event_mask_half_full</b></td></tr>
<tr class="memdesc:a86f8875bf98bf422e046a85bd9a72240"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL event mask that represents the half full state. <br /></td></tr>
<tr class="separator:a86f8875bf98bf422e046a85bd9a72240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48cf21d9a99302dbeb3e479866caae3a"><td class="memItemLeft" align="right" valign="top"><a id="a48cf21d9a99302dbeb3e479866caae3a" name="a48cf21d9a99302dbeb3e479866caae3a"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>event_rx_complete</b></td></tr>
<tr class="memdesc:a48cf21d9a99302dbeb3e479866caae3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL event mask that represents async rx complete. <br /></td></tr>
<tr class="separator:a48cf21d9a99302dbeb3e479866caae3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5d98affaae5cf6475ccf5d5ac7588c6"><td class="memItemLeft" align="right" valign="top"><a id="aa5d98affaae5cf6475ccf5d5ac7588c6" name="aa5d98affaae5cf6475ccf5d5ac7588c6"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>event_tx_complete</b></td></tr>
<tr class="memdesc:aa5d98affaae5cf6475ccf5d5ac7588c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL event mask that represents async tx complete. <br /></td></tr>
<tr class="separator:aa5d98affaae5cf6475ccf5d5ac7588c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae494185e0ccae1a2e238c7025764bbf9"><td class="memItemLeft" align="right" valign="top"><a id="ae494185e0ccae1a2e238c7025764bbf9" name="ae494185e0ccae1a2e238c7025764bbf9"></a>
<a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>err_invalid_pin</b></td></tr>
<tr class="memdesc:ae494185e0ccae1a2e238c7025764bbf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error code for invalid pin. <br /></td></tr>
<tr class="separator:ae494185e0ccae1a2e238c7025764bbf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a165f5d2699fa7454c60ff05255439027"><td class="memItemLeft" align="right" valign="top"><a id="a165f5d2699fa7454c60ff05255439027" name="a165f5d2699fa7454c60ff05255439027"></a>
<a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>err_invalid_arg</b></td></tr>
<tr class="memdesc:a165f5d2699fa7454c60ff05255439027"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error code for invalid argument. <br /></td></tr>
<tr class="separator:a165f5d2699fa7454c60ff05255439027"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f83605d15a9fc3b51a97693074ce041"><td class="memItemLeft" align="right" valign="top"><a id="a3f83605d15a9fc3b51a97693074ce041" name="a3f83605d15a9fc3b51a97693074ce041"></a>
<a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>err_clock</b></td></tr>
<tr class="memdesc:a3f83605d15a9fc3b51a97693074ce041"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error code for invalid clock frequency. <br /></td></tr>
<tr class="separator:a3f83605d15a9fc3b51a97693074ce041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71534ffd0564650b16f451961a704544"><td class="memItemLeft" align="right" valign="top"><a id="a71534ffd0564650b16f451961a704544" name="a71534ffd0564650b16f451961a704544"></a>
<a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>err_not_supported</b></td></tr>
<tr class="memdesc:a71534ffd0564650b16f451961a704544"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error code for configuration not supported. <br /></td></tr>
<tr class="separator:a71534ffd0564650b16f451961a704544"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="ae21faa347539cbf2969539748d346e64" name="ae21faa347539cbf2969539748d346e64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae21faa347539cbf2969539748d346e64">&#9670;&nbsp;</a></span>invoke_user_callback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* _cyhal_audioss_interface_t::invoke_user_callback) (struct _cyhal_audioss_s *obj, uint32_t hal_event)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Invoke the user callback with the specified HAL event. </p>
<p >Only called after the user callback has been verified to not be null. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Hardware Abstraction Layer (HAL)</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
